Add Entra ID OAuthe2 token support #29032

asaflevi-ms · 2024-05-08T15:22:03Z

Add support for AAD token credentials

a private preview
a public preview
GA release

openapi-pipeline-app · 2024-05-08T15:22:07Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-05-08T15:22:07Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

Compared specs (v0.10.9)	new version	base version
openapi.json	2024-04-01(2a7ae6b)	2024-04-01(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-2024-04-01	package-2024-04-01(2a7ae6b)	package-2024-04-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ OperationId	OperationId for put method should contain both 'Create' and 'Update' Location: HealthInsights/stable/2024-04-01/openapi.json#L141
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L1003
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L1210
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L1331
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L1980
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2007
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2043
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2047
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2051
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2055
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2082
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2086
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2090
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2797
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/stable/2024-04-01/openapi.json#L2802

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-05-08T15:22:08Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-05-08T15:22:08Z

Generated ApiView

Language	Package Name	ApiView Link
TypeSpec	HealthInsights.OpenAPI	https://apiview.dev/Assemblies/Review/652055157260479f95c0f6ec96285993?revisionId=009243363bd44128b75f03b21fefc4f9
Swagger	HealthInsights	https://apiview.dev/Assemblies/Review/0aef26c4ab2c438db6b3089e208c348c?revisionId=b794cbe4d9ab47ffba0c41f1ed45b2b8

vicancy · 2024-05-10T12:11:15Z

specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json

    }
  ],
  "securityDefinitions": {
+    "AADToken": {
+      "type": "oauth2",
+      "description": "The Azure Active Directory OAuth2 Flow",


Azure Active Directory is now Microsoft Entra ID https://learn.microsoft.com/en-us/entra/fundamentals/how-to-rename-azure-ad

@vicancy .
Is this what you meant ?

openapi-pipeline-app · 2024-05-21T09:02:01Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

asaflevi-ms · 2024-05-30T10:13:56Z

@marclerwick, @vicancy , @catalinaperalta , @weidongxu-microsoft
Can one of you review this PR?
If ok, please approve and merge.

CC: @koen-mertens

specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp

….tsp Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>

openapi-pipeline-app · 2024-05-30T20:25:25Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

catalinaperalta · 2024-05-30T22:42:19Z

/azp run

openapi-pipeline-app · 2024-05-30T22:42:22Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

azure-pipelines · 2024-05-30T22:42:25Z

Pull request contains merge conflicts.

weidongxu-microsoft

Are we adding AAD support to an existing api-version (that already serving customer)?

openapi-pipeline-app · 2024-06-02T12:23:14Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

asaflevi-ms · 2024-06-02T12:25:43Z

Are we adding AAD support to an existing api-version (that already serving customer)?

@weidongxu-microsoft
Actually, Cognitive Services support it.
We just need to show this in our spec so we can correctly generate SDKs.

weidongxu-microsoft · 2024-06-03T01:53:14Z

specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json

+        "requestId": {
+          "type": "object",
+          "description": "An opaque, globally-unique, server-generated string identifier for the request.",
+          "properties": {
+            "response": {
+              "$ref": "#/definitions/Azure.Core.RequestIdResponseHeader"
+            }
+          },
+          "required": [
+            "response"
+          ]
        }
      },
      "required": [
-        "error"
+        "error",
+        "requestId"


I don't see where these changes comes from.

There is no update to typespec file about these in this PR? -- maybe caused by the conflict in branch?

@weidongxu-microsoft
Correct.
Fixed by merge from main.

weidongxu-microsoft · 2024-06-03T01:58:12Z

@weidongxu-microsoft Actually, Cognitive Services support it. We just need to show this in our spec so we can correctly generate SDKs.

OK. For a recent procedure change, you can add BreakingChanges-Approved-Bugfix if these is no change in backend, and the typespec/swagger change is to "fix" API definition (in this case auth definition).

Though you need to resolve the conflict first.

* Add AAD OAuthe2 token support * EntraIdToken * Update specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com> * remove suppression * update spec after merge --------- Co-authored-by: koen-mertens <138520871+koen-mertens@users.noreply.github.com> Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>

Add AAD OAuthe2 token support

eda16d5

asaflevi-ms requested a review from a team as a code owner May 8, 2024 15:22

asaflevi-ms requested review from vicancy and marclerwick and removed request for a team May 8, 2024 15:22

AzureRestAPISpecReview added data-plane TypeSpec Authored with TypeSpec labels May 8, 2024

vicancy reviewed May 10, 2024

View reviewed changes

EntraIdToken

7c08552

asaflevi-ms changed the title ~~Add AAD OAuthe2 token support~~ Add Entra ID OAuthe2 token support May 21, 2024

catalinaperalta reviewed May 30, 2024

View reviewed changes

specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp Outdated Show resolved Hide resolved

specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp Outdated Show resolved Hide resolved

Update specification/ai/HealthInsights/HealthInsights.OpenAPI/service…

4368b31

….tsp Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>

weidongxu-microsoft reviewed May 31, 2024

View reviewed changes

remove suppression

6292b81

weidongxu-microsoft approved these changes Jun 3, 2024

View reviewed changes

weidongxu-microsoft reviewed Jun 3, 2024

View reviewed changes

Merge branch 'main' into asaflevi/feature/support-aadtoken

6b8c86f

update spec after merge

2a7ae6b

weidongxu-microsoft merged commit cd47418 into Azure:main Jun 3, 2024
31 of 32 checks passed

asaflevi-ms deleted the asaflevi/feature/support-aadtoken branch January 12, 2025 07:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Entra ID OAuthe2 token support #29032

Add Entra ID OAuthe2 token support #29032

asaflevi-ms commented May 8, 2024

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

vicancy May 10, 2024

asaflevi-ms May 21, 2024

openapi-pipeline-app bot commented May 21, 2024

asaflevi-ms commented May 30, 2024

openapi-pipeline-app bot commented May 30, 2024

catalinaperalta commented May 30, 2024

openapi-pipeline-app bot commented May 30, 2024

azure-pipelines bot commented May 30, 2024

weidongxu-microsoft left a comment

openapi-pipeline-app bot commented Jun 2, 2024

asaflevi-ms commented Jun 2, 2024

weidongxu-microsoft Jun 3, 2024 •

edited

Loading

asaflevi-ms Jun 3, 2024 •

edited

Loading

weidongxu-microsoft commented Jun 3, 2024 •

edited

Loading

Add Entra ID OAuthe2 token support #29032

Add Entra ID OAuthe2 token support #29032

Conversation

asaflevi-ms commented May 8, 2024

openapi-pipeline-app bot commented May 8, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented May 8, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 8, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 8, 2024 • edited Loading

Generated ApiView

vicancy May 10, 2024

Choose a reason for hiding this comment

asaflevi-ms May 21, 2024

Choose a reason for hiding this comment

openapi-pipeline-app bot commented May 21, 2024

asaflevi-ms commented May 30, 2024

openapi-pipeline-app bot commented May 30, 2024

catalinaperalta commented May 30, 2024

openapi-pipeline-app bot commented May 30, 2024

azure-pipelines bot commented May 30, 2024

weidongxu-microsoft left a comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Jun 2, 2024

asaflevi-ms commented Jun 2, 2024

weidongxu-microsoft Jun 3, 2024 • edited Loading

Choose a reason for hiding this comment

asaflevi-ms Jun 3, 2024 • edited Loading

Choose a reason for hiding this comment

weidongxu-microsoft commented Jun 3, 2024 • edited Loading

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 8, 2024 •

edited

Loading

weidongxu-microsoft Jun 3, 2024 •

edited

Loading

asaflevi-ms Jun 3, 2024 •

edited

Loading

weidongxu-microsoft commented Jun 3, 2024 •

edited

Loading